Introducing the eFax Enterprise API
This highly scalable, standards-based, RESTful application programming interface (API) exposes the functionality of the Consensus eFax Corporate® platform to key trusted partners who will use it to integrate fax capability into their own applications.
Designed for easy integration with mission-critical applications in high-volume production fax environments — especially for highly regulated industries where compliance and security come first — our API provides calls for sending, receiving, deleting, and searching for faxes.
What Do You Want To Do?
Use the Fax Service API
The Fax Services API provides calls for supporting fax transmissions, downloading fax images and metadata, using webhooks for secure inbound and outbound fax notifications, deleting faxes, and using search parameters to retrieve lists of sent and received faxes.
- Understand the basic structure of the URLs used in this API.
- View the Fax Services API Specification and send test requests and monitor system responses.
- Authenticate your calls to this API.
- View and use the sample code contained in the Postman Collection.
- View message files size/payload limits.
- View a list of supported file types for outbound faxing.
- View the applicable sent transmission error codes.
- Understand available methods for receiving faxes, including HMAC authentication.
- Understand available methods for getting sent fax disposition notifications, including HMAC authentication.
- Understand how to use the GET /notifications endpoint for inbound and outbound webhook notifications.
- Understand how to cancel a fax.
- Understand how to use custom fax headers.
- Refer to the Enterprise API Quick Start Guide.
Use the Admin API
The Admin API supports administration functions for eFax Corporate accounts, including account provisioning and maintenance, number management, and managing authorizations for using the Fax Services API.
- Understand the basic structure of the URLs used in this API.
- View the Admin API Specification and send test requests and monitor system responses.
- Authenticate your calls to this API.
- Understand how to use the Admin Portal API Management functions, including granting administrators access to the API, creating AppIDs, managing group users, and adding additional API keys.
- View applicable time zone values in the Admin API User Management endpoints.
- View the success and error result codes used by the Admin API.
Troubleshooting and Feedback
- Troubleshoot your API.
- Send feedback to the Production Faxing API and Documentation teams, or contact us for assistance.
- Return to the landing page.
On Data Sovereignty
Data sovereignty — the concept that digital information is subject to the laws of the country in which it is located — is crucial to the way multinational corporations do business today. To maintain a presence in certain countries and regions, you must be able to support the control, transport, and storage of data within that country according to that country's laws. The eFax Enterprise API's Data Sovereignty Solution helps you achieve these goals and keep the data management portion of your business running smoothly no matter where you do business.
To request integration information for your specific data sovereign region, please contact your Account Manager or Sales Engineer.
Navigation Tip! To return to this task list from any page in the User Guide, click the logo at the top of that page.